/* libwatopt++ - Optimization Toolkit
 *
 * Copyright (c) 2007 Christopher Alexander Watford
 * <christopher.watford@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 * $Id: ga.hpp 2 2007-05-06 18:01:15Z christopher.watford $
 */

#if _MSC_VER > 1000
#pragma once
#endif /* _MSC_VER > 1000 */

#ifndef _GA_HPP_
#define _GA_HPP_

#include <cstdlib>
#include <vector>

#include <opt.hpp>

namespace watopt
{

   class IGeneticAlgorithmInstrumentation
   {
   public:
      virtual void Start(const std::vector<IFitnessImplementation*>& pop,
         double minFit, double maxFit, double avgFit, double variance) = 0;
      virtual void ParentsSelected(const IFitnessImplementation* parent1,
         const IFitnessImplementation* parent2) = 0;
      virtual void PopulaceConverged(size_t generation,
         const std::vector<IFitnessImplementation*>& pop,
         double fitness) = 0;
      virtual void EndGeneration(size_t generation,
         const std::vector<IFitnessImplementation*>& pop,
         double minFit, double maxFit, double avgFit, double variance) = 0;
      virtual void Stop(const std::vector<IFitnessImplementation*>& pop,
         double minFit, double maxFit, double avgFit, double variance) = 0;
   };

   class GeneticAlgorithmOpt : public IOptimizer
   {
   public:
	   GeneticAlgorithmOpt(size_t populationSize, size_t generations);

	   virtual IFitnessImplementation* Solve(void);
      virtual void GetSolutions(std::vector<IFitnessImplementation*>& solutions) const;
	   virtual void Initialize(void);

      virtual void Crossover(const IFitnessImplementation* c1, const IFitnessImplementation* c2,
         std::vector<IFitnessImplementation*>& children) const = 0;
	   virtual void Mutate(IFitnessImplementation* member) const = 0;
	   virtual IFitnessImplementation* Generate(void) const = 0;

      bool EndBreeding(size_t breedings, size_t children);
	   virtual void Reaper(std::vector<IFitnessImplementation*>& pool);
      virtual bool PopulaceConverged(std::vector<IFitnessImplementation*>& pool);
	   virtual void Selection(const std::vector<IFitnessImplementation*>& pool,
		   IFitnessImplementation** parent1, IFitnessImplementation** parent2,
         double minFit, double maxFit, double avgFit, double variance);

      void SetInstrumentation(IGeneticAlgorithmInstrumentation* instrument) { _m_Instrument = instrument; }
      IGeneticAlgorithmInstrumentation* GetInstrumentation(void) const { return _m_Instrument; }

   private:
      virtual void GatherStatistics(const std::vector<IFitnessImplementation*>& pool);

	   size_t _m_PopSize;
	   size_t _m_MaxGenerations;
      double _m_AvgFit;
      double _m_MinFit;
      double _m_MaxFit;
      double _m_Variance;

   protected:
      IGeneticAlgorithmInstrumentation* _m_Instrument;
	   std::vector<IFitnessImplementation*> _m_Population;
   };

}

#endif /* !defined(_GA_HPP_) */